-
Notifications
You must be signed in to change notification settings - Fork 69
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Mark deprecated components as deprecated using JSDoc/TypeScript #3240
Mark deprecated components as deprecated using JSDoc/TypeScript #3240
Conversation
Thanks for the pull request, @bradenmacdonald! What's next?Please work through the following steps to get your changes ready for engineering review: 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by Where can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:
When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
✅ Deploy Preview for paragon-openedx ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3240 +/- ##
=======================================
Coverage 93.27% 93.27%
=======================================
Files 249 249
Lines 4401 4401
Branches 1037 1002 -35
=======================================
Hits 4105 4105
- Misses 290 293 +3
+ Partials 6 3 -3 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! I am sure this will be very useful for consumers! 💯
Thanks for the quick review @PKulkoRaccoonGang ! |
🎉 This PR is included in version 22.9.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
🎉 This PR is included in version 23.0.0-alpha.7 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
On the docs site, many components are marked as deprecated:
This PR updates the types so that those same components will appear as deprecated if used in an IDE:
As you can see, the message about the replacement components is also shown in by VS Code.
Deploy Preview
No discernible changes to the docs site.
Merge Checklist
n/a
Post-merge Checklist